<div class="well well-small api-menu">
	<?php $this->widget('ApiMenuWidget'); ?>
</div>
<?php
$this->beginWidget('bootstrap.widgets.TbBox', array(
	'title' => false,
	'htmlOptions' => array('class' => 'api-doc'),
));
?>

<h2>计数搜索</h2>
<p>根据查询条件获取匹配估算数量。</p>

<h4>URL</h4>
<p><code><?php echo $this->createApiUrl(null, 'http'); ?></code></p>

<h4>请求、响应方式</h4>
<p>POST 请求，JSON 响应。</p>

<h4>请求参数</h4>
<table class="table table-bordered">
	<tr><th>名称</th><th>必填</th><th>类型/范围</th><th>说明</th></tr>
	<tr>
		<td>access_token</td>
		<td>true</td>
		<td>string</td>
		<td>在登录授权后得到，参见<?php echo CHtml::link('如何登入', array('api/login')); ?>。</td>
	</tr>
    <tr>
        <td>project</td>
        <td>true</td>
        <td>string</td>
        <td>项目名称。</td>
    </tr>
    <tr>
        <td>query</td>
        <td>true</td>
        <td>string,array</td>
        <td>查询语句，多条查询时采用数组传递但不支持 range</td>
    </tr>
    <tr>
        <td>fuzzy</td>
        <td>false</td>
        <td>string</td>
        <td>是否开启模糊搜索，值为 yes|no，默认为 no。</td>
    </tr>
    <tr>
        <td>cut_percent</td>
        <td>false</td>
        <td>int</td>
        <td>剔除匹配百分比低于此值的文档，值范围 0-100，默认为 0。</td>
    </tr>
    <tr>
        <td>cut_weight</td>
        <td>false</td>
        <td>float</td>
        <td>剔除权重低于此值的文档，值范围 0.1-25.5，默认 0 不剔除。</td>
    </tr>
    <tr>
        <td>synonym</td>
        <td>false</td>
        <td>string</td>
        <td>是否开启同义词搜索，值为 yes|no，默认为 no。</td>
    </tr>
    <tr>
        <td>range</td>
        <td>false</td>
        <td>string</td>
        <td>区间搜索 <em>field:from..to</em> 多个区间之间用逗号分开，<br /><em>from</em> 或 <em>to</em> 可省略其中之一。</td>
    </tr>
    <tr>
        <td>scws_multi</td>
        <td>false</td>
        <td>int</td>
        <td>scws 复合分词等级，默认为 3，可选值 0-15。</td>
    </tr>
</table>

<h4>注意事项</h4>
<p>获得的结果数据量为估算数据。</p>

<h4>成功返回</h4>
<p>
	当 query 类型为 string 时返回：
	<pre>{ "result":true, "count":123 }</pre>

	当 query 类型为数组时，如传入 <em>query[key1]=q1&query[key2]=q2</em>，则返回：
	<pre>{ "result":true, "count":{"key1":12,"key2":23} }</pre>
</p>

<h4>结果说明</h4>
<table class="table table-bordered">
	<tr><th>名称</th><th>含义说明</th></tr>
	<tr>
		<td>result</td>
		<td>操作是否成功。</td>
	</tr>
	<tr>
		<td>count</td>
		<td>符合搜索条件的匹配估算数量。</td>
	</tr>
</table>

<h4>出错情况</h4>
<p>出错时 HTTP 的响应状态码为 200 以外的数值，含义如下：</p>
<table class="table table-bordered">
	<tr><th>HTTP 状态</th><th>出错说明</th></tr>
	<tr>
		<td>500</td>
		<td>内部错误，通常是程序或数据库出错。</td>		
	</tr>
</table>

<?php $this->endWidget();?>
